Project-Specific Portability

Project-specific portability is intended for the redistribution of a complete project, including information extracted from build environments, such as locations of files, Include Paths and CLI Macro Definitions. As a result, the setting for the source code PROJECT_ROOT needs to be set to a location that suits your organization’s build dependency environment. For more information, refer to Setting the Root Directory of Your Sources.

A Helix QAC project folder serves as the project identifier and contains the following information required for portability:

  • The "prqaproject.xml" file.
  • The source folder.
  • The "prqa" folder containing the following sub-folders:
    • "upgrade" - contains files relating to any upgrade of the project from a previous version. Otherwise, the sub-folder may not be present.
    • "unified" - populated only if the project is "Unified".
    • "configs" - contains at least one configuration (the default is Initial), although others may be added. Refer to Projects with Multiple Configurations for more information.

Each configuration sub-folder within "configs" contains the following:

  • "config" - contains the following: a single ACF, a single RCF, and one or more CCTs.
  • "logs" - location where logfiles are stored, if project logging is enabled.
  • "output" - default location where qacli view output is created.
  • "reports" - default location where reports are created.

Everything else is non-portable and is not needed to re-analyze the project on a different machine, and therefore does not need to be checked in.

In the case of project-specific portability, the source files must be in the same location relative to the source code PROJECT_ROOT on the new machine.

Most Version Control systems have an "ignore" mechanism that is used to ignore certain files and file types. This same mechanism should be used to ignore all nonportable files and directories contained in the project directory structure, for example any cip folder that may have been generated.